BOT UX API

GET /balanceEnquiry

This operation retrieves a balance entity

Request

This section defines all the possible data structures sent by the client when consuming the method.

URL

https://esb-dev.lla.com/bot-ux/v1/{businessId}/balanceEnquiry

uri Param

Security Headers

Headers

Response

In this section all the possible data structures received by the client at the moment of responding the method are defined.

Possible success response

[200]

OK - balance enquiry request processed successfully, response body contains an entity corresponding to the requested resource.

Success Response - PR

{
    "id": "8211990010028298",
    "accountType": "RES",
    "description": "JENIFFER GUTIERREZ",
    "lastModified": "2023-09-21T00:00:00.000-04:00",
    "name": "JENIFFER GUTIERREZ",
    "paymentStatus": "",
    "state": "NORMAL",
    "accountBalance": [
        {
            "amount": {
                "unit": "USD",
                "value": 94.34
            },
            "balanceType": "ReceivableBalance",
            "validFor": {
                "startDateTime": "2023-09-21T00:00:00.000-04:00",
                "endDateTime": "2023-10-20T00:00:00.000-04:00"
            }
        },
        {
            "amount": {
                "unit": "USD",
                "value": 94.34
            },
            "balanceType": "LastPaymentAmount",
            "validFor": {
                "startDateTime": "",
                "endDateTime": "2023-09-08T00:00:00.000-04:00"
            }
        }
    ],
    "accountRelationship": [
        {
            "relationshipType": "contains",
            "account": {
                "id": "8211990010028298",
                "description": "RES JENIFFER GUTIERREZ",
                "name": "JENIFFER GUTIERREZ",
                "@type": "BillingAccount"
            },
            "validFor": {
                "startDateTime": "2021-06-21T00:00:00.000-04:00",
                "endDateTime": ""
            }
        }
    ],
    "billStructure": {
        "cycleSpecification": {
            "name": "monthly Billing",
            "dateShift": 21,
            "frequency": "monthly"
        },
        "presentationMedia": [
            {
                "name": "Mail"
            }
        ]
    },
    "contact": [
        {
            "contactName": "JENIFFER GUTIERREZ",
            "contactType": "Primary",
            "partyRoleType": "Owner",
            "contactMedium": [
                {
                    "mediumType": "PostalAddress",
                    "preferred": true,
                    "characteristic": {
                        "city": "SAN JUAN",
                        "country": "USA",
                        "postCode": "009231227",
                        "street1": "HILL TOWER 525 CALLE 1 APT 1018"
                    }
                },
                {
                    "mediumType": "Phone",
                    "characteristic": {
                        "contactType": "Home",
                        "phoneNumber": "7875518661"
                    }
                },
                {
                    "mediumType": "Phone",
                    "characteristic": {
                        "contactType": "Business",
                        "phoneNumber": "7872320021"
                    }
                },
                {
                    "mediumType": "Email",
                    "characteristic": {
                        "emailAddress": "JENIFFERG@GMAIL.COM"
                    }
                }
            ],
            "relatedParty": {
                "id": "6789",
                "name": "JENIFFER GUTIERREZ",
                "role": "Owner",
                "@type": "relatedParty"
            }
        }
    ],
    "creditLimit": {
        "unit": "USD",
        "value": 100.00
    },
    "defaultPaymentMethod": {
        "id": "E",
        "name": "EFT"
    },
    "financialAccount": {
        "id": "2063",
        "accountBalance": {
            "balanceType": "ReceivableBalance",
            "amount": {
                "unit": "USD",
                "value": 21
            },
            "validFor": {
                "startDateTime": "2023-09-21T00:00:00.000-04:00",
                "endDateTime": "2023-10-20T00:00:00.000-04:00"
            }
        },
        "@referredType": "financialAccount"
    },
    "paymentPlan": [
        {
            "paymentFrequency": "01",
            "totalAmount": {
                "unit": "USD",
                "value": 0.00
            },
            "planType": "Auto Pay Enable"
        }
    ],
    "characteristic": [
        {
            "name": "LocationId",
            "value": "00923122700183"
        },
        {
            "name": "DunningGroup",
            "value": "090"
        },
        {
            "name": "autoPayDate",
            "value": "2023-10-08T00:00:00.000-04:00"
        },
        {
            "name": "DebitDay",
            "value": "08"
        }
    ],
    "relatedParty": [
        {
            "id": "1101523939861",
            "name": "JENIFFER GUTIERREZ",
            "role": "Customer",
            "@referredType": "Customer"
        }
    ],
    "@type": "BillingAccount"
}